/* ***** BEGIN LICENSE BLOCK *****
 * This file is part of Natron <https://natrongithub.github.io/>,
 * (C) 2018-2020 The Natron developers
 * (C) 2013-2018 INRIA and Alexandre Gauthier-Foichat
 *
 * Natron is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Natron is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Natron.  If not, see <http://www.gnu.org/licenses/gpl-2.0.html>
 * ***** END LICENSE BLOCK ***** */

#ifndef NATRON_ENGINE_IMAGECACHEKEY_H
#define NATRON_ENGINE_IMAGECACHEKEY_H

// ***** BEGIN PYTHON BLOCK *****
// from <https://docs.python.org/3/c-api/intro.html#include-files>:
// "Since Python may define some pre-processor definitions which affect the standard headers on some systems, you must include Python.h before any standard headers are included."
#include <Python.h>
// ***** END PYTHON BLOCK *****

#include "Engine/CacheEntryKeyBase.h"

NATRON_NAMESPACE_ENTER

struct ImageCacheKeyPrivate;
class ImageCacheKey
: public CacheEntryKeyBase
{
public:

    ImageCacheKey();

    ImageCacheKey(U64 nodeTimeViewVariantHash,
                  U64 layerIDHash,
                  const RenderScale& proxyScale,
                  const std::string& pluginID);

    virtual ~ImageCacheKey();

    U64 getNodeTimeVariantHashKey() const;

    const RenderScale& getProxyScale() const;

    virtual void toMemorySegment(IPCPropertyMap* properties) const OVERRIDE FINAL;

    virtual CacheEntryKeyBase::FromMemorySegmentRetCodeEnum fromMemorySegment(const IPCPropertyMap& properties) OVERRIDE FINAL;
    
    virtual int getUniqueID() const OVERRIDE FINAL;


private:


    virtual void appendToHash(Hash64* hash) const OVERRIDE FINAL;

    boost::scoped_ptr<ImageCacheKeyPrivate> _imp;
};

inline
ImageCacheKeyPtr toImageCacheKey(const CacheEntryKeyBasePtr& key)
{
    return boost::dynamic_pointer_cast<ImageCacheKey>(key);
}

NATRON_NAMESPACE_EXIT

#endif // NATRON_ENGINE_IMAGECACHEKEY_H
